/*
 * MIT License
 *
 * Copyright (c) 2019 Mr.css
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

package cn.seaboot.commons.lang;

/**
 * <table>
 * <tr><td>all	                    </td><td>to suppress all warnings</td></tr>
 * <tr><td>boxing                   </td><td>to suppress warnings relative to boxing/unboxing operations</td></tr>
 * <tr><td>cast	                    </td><td>to suppress warnings relative to cast operations</td></tr>
 * <tr><td>dep-ann                  </td><td>to suppress warnings relative to deprecated annotation</td></tr>
 * <tr><td>deprecation              </td><td>to suppress warnings relative to deprecation</td></tr>
 * <tr><td>fallthrough              </td><td>to suppress warnings relative to missing breaks in switch statements</td></tr>
 * <tr><td>finally 	                </td><td>to suppress warnings relative to finally block that don’t return</td></tr>
 * <tr><td>hiding	                </td><td>to suppress warnings relative to locals that hide variable</td></tr>
 * <tr><td>incomplete-switch        </td><td>to suppress warnings relative to missing entries in a switch statement (enum case)</td></tr>
 * <tr><td>nls	                    </td><td>to suppress warnings relative to non-nls string literals</td></tr>
 * <tr><td>null                     </td><td>to suppress warnings relative to null analysis</td></tr>
 * <tr><td>rawtypes	                </td><td>to suppress warnings relative to un-specific types when using generics on class params</td></tr>
 * <tr><td>restriction	            </td><td>to suppress warnings relative to usage of discouraged or forbidden references</td></tr>
 * <tr><td>serial	                </td><td>to suppress warnings relative to missing serialVersionUID field for a serializable class</td></tr>
 * <tr><td>static-access	        </td><td>to suppress warnings relative to incorrect static access</td></tr>
 * <tr><td>synthetic-access         </td><td>to suppress warnings relative to unoptimized access from inner classes</td></tr>
 * <tr><td>unchecked	            </td><td>to suppress warnings relative to unchecked operations</td></tr>
 * <tr><td>unqualified-field-access </td><td>to suppress warnings relative to field access unqualified</td></tr>
 * <tr><td>unused	                </td><td>to suppress warnings relative to unused code</td></tr>
 * </table>
 * <p>
 * 用于压制IDE中的警告，做成常量，方便调用。
 * </p>
 *
 * @author Mr.css
 * @version 2022-02-14 11:25
 */
public class Warning {
    private Warning() {
    }

    /**
     * 通常是忽视泛型，强制转换引起的警告.
     * <p> E.G.:类似于 json 工具，转list的函数通常是不指定泛型的，这时候会出现警告。</p>
     * <p> to suppress warnings relative to unused code.</p>
     */
    public static final String UNCHECKED = "unchecked";

    /**
     * 通常是未知泛型引起的警告.
     * <p> to suppress warnings relative to un-specific types when using generics on class params
     */
    public static final String RAW_TYPES = "rawtypes";

    /**
     * 无序列化 ID
     * <p> to suppress warnings relative to missing serialVersionUID field for a serializable class
     */
    public static final String SERIAL = "serial";

    /**
     * 使用弃用 API 导致的警告
     * <p> to suppress warnings relative to deprecation
     */
    public static final String DEPRECATION = "deprecation";

    /**
     * 不稳定的 API 警告
     */
    public static final String UNSTABLE_API_USAGE = "UnstableApiUsage";

    /**
     * 压制全部警告，无法确定警告类型类型，直接使用这个。
     * <p> all to suppress all warnings
     */
    public static final String ALL = "all";
}

